
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright 2019-2024 [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>create-javamail-resource</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>create-javamail-resource</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="create-jacc-provider.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-jdbc-connection-pool.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="create-javamail-resource-1"></a><a id="GSRFM00035"></a><a id="create-javamail-resource"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_create_javamail_resource">create-javamail-resource</h2>
<div class="sectionbody">
<div class="paragraph">
<p>creates a JavaMail session resource</p>
</div>
<div id="sthref312" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] create-javamail-resource [--help]
[--target target] --mailhost hostname
--mailuser username --fromaddress address [--storeprotocol storeprotocol]
[--storeprotocolclass storeprotocolclass] [--transprotocol transprotocol]
[--transprotocolclass transprotocolclass] [--debug={false|true}] [--enabled={true|false}]
[--description resource-description] [--property (name=value)[:name=value]*] jndi-name</code></pre>
</div>
</div>
<div id="sthref313" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>create-javamail-resource</code> subcommand creates a JavaMail session
resource.</p>
</div>
<div class="paragraph">
<p>This subcommand is supported in remote mode only.</p>
</div>
<div id="sthref314" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--target</code></dt>
<dd>
<p>This option specifies the target for which you are creating the
JavaMail session resource. Valid values are:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>server</code></dt>
<dd>
<p>Creates the resource for the default server instance. This is the
default value.</p>
</dd>
<dt class="hdlist1"><code>domain</code></dt>
<dd>
<p>Creates the resource for the domain.</p>
</dd>
<dt class="hdlist1">cluster_name</dt>
<dd>
<p>Creates the resource for every server instance in the cluster.</p>
</dd>
<dt class="hdlist1">instance_name</dt>
<dd>
<p>Creates the resource for a particular server instance.</p>
</dd>
</dl>
</div>
</dd>
<dt class="hdlist1"><code>--mailhost</code></dt>
<dd>
<p>The DNS name of the default mail server. The connect methods of the
Store and Transport objects use this value if a protocol-specific host
property is not supplied. The name must be resolvable to an actual
host name.</p>
</dd>
<dt class="hdlist1"><code>--mailuser</code></dt>
<dd>
<p>The name of the mail account user provided when connecting to a mail
server. The connect methods of the Store and Transport objects use
this value if a protocol-specific username property is not supplied.</p>
</dd>
<dt class="hdlist1"><code>--fromaddress</code></dt>
<dd>
<p>The email address of the default user, in the form
username`@<code>host</code>.`domain.</p>
</dd>
<dt class="hdlist1"><code>--storeprotocol</code></dt>
<dd>
<p>The mail server store protocol. The default is <code>imap</code>. Change this
value only if you have reconfigured the \{product---name}'s mail
provider to use a non-default store protocol.</p>
</dd>
<dt class="hdlist1"><code>--storeprotocolclass</code></dt>
<dd>
<p>The mail server store protocol class name. The default is
	<code>org.eclipse.angus.mail.imap.IMAPStore</code>. Change this value only if you have
reconfigured the \{product---name}'s mail provider to use a nondefault
store protocol.</p>
</dd>
<dt class="hdlist1"><code>--transprotocol</code></dt>
<dd>
<p>The mail server transport protocol. The default is <code>smtp</code>. Change this
value only if you have reconfigured the \{product---name}'s mail
provider to use a nondefault transport protocol.</p>
</dd>
<dt class="hdlist1"><code>--transprotocolclass</code></dt>
<dd>
<p>The mail server transport protocol class name. The default is
	<code>org.eclipse.angus.mail.smtp.SMTPTransport</code>. Change this value only if you have
reconfigured the \{product---name}'s mail provider to use a nondefault
transport protocol.</p>
</dd>
<dt class="hdlist1"><code>--debug</code></dt>
<dd>
<p>If set to true, the server starts up in debug mode for this resource.
If the JavaMail log level is set to <code>FINE</code> or <code>FINER</code>, the debugging
output will be generated and will be included in the server log file.
The default value is false.</p>
</dd>
<dt class="hdlist1"><code>--enabled</code></dt>
<dd>
<p>If set to true, the resource is enabled at runtime. The default value
is true.</p>
</dd>
<dt class="hdlist1"><code>--description</code></dt>
<dd>
<p>Text providing some details of the JavaMail resource.</p>
</dd>
<dt class="hdlist1"><code>--property</code></dt>
<dd>
<p>Optional attribute name/value pairs for configuring the JavaMail
resource. The \{product---name}-specific <code>mail-</code> prefix is converted
to the standard mail prefix. The JavaMail API documentation lists the
properties you might want to set.</p>
</dd>
</dl>
</div>
<div id="sthref315" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">jndi-name</dt>
<dd>
<p>The JNDI name of the JavaMail resource to be created. It is a
recommended practice to use the naming subcontext prefix <code>mail/</code> for
JavaMail resources.</p>
</dd>
</dl>
</div>
<div id="sthref316" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM492"></a><a id="sthref317"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Creating a JavaMail Resource</p>
</div>
<div class="paragraph">
<p>This example creates a JavaMail resource named <code>mail/MyMailSession</code>. The
JNDI name for a JavaMail session resource customarily includes the
<code>mail/</code> naming subcontext.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; create-javamail-resource --mailhost localhost
--mailuser sample --fromaddress sample@sun.com mail/MyMailSession
Command create-javamail-resource executed successfully.</code></pre>
</div>
</div>
<div id="sthref318" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>subcommand executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the subcommand</p>
</dd>
</dl>
</div>
<div id="sthref319" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="delete-javamail-resource.html#delete-javamail-resource-1"><code>delete-javamail-resource</code>(1)</a>,
<a href="list-javamail-resources.html#list-javamail-resources-1"><code>list-javamail-resources</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="create-jacc-provider.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-jdbc-connection-pool.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
